Skip to content

Update README with citation #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
msanatan merged 2 commits into from
Jan 21, 2026
Merged

Update README with citation #591

msanatan merged 2 commits into from
Jan 21, 2026

Conversation

@Scriptwonder
Copy link
Collaborator

@Scriptwonder Scriptwonder commented Jan 20, 2026 •
edited by coderabbitai bot
Loading

Added citation for research. @JosvanderWesthuizen @msanatan Let me know if the Coplay team is okay with this.

Summary by Sourcery

Documentation:

  • Document how to cite Unity-MCP in academic research via a collapsible BibTeX citation block in the README.

Summary by CodeRabbit

  • Documentation
    • Added two "Citation for Research" sections that provide BibTeX entries for MCP-Unity: Protocol-Driven Framework for Interactive 3D Authoring, placed in two convenient locations within the project README.

✏️ Tip: You can customize this high-level summary in your review settings.

@Scriptwonder
Update README with citation and AI tools information
b83f0ef 
Added citation for research and details about Unity AI tools.
Copilot AI review requested due to automatic review settings January 20, 2026 04:58
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 20, 2026 •
edited
Loading

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a collapsible research citation section with a BibTeX entry to the README to guide researchers on how to cite the Unity-MCP project.

File-Level Changes

Change Details Files
Document how to cite the Unity-MCP project for research in the README.
  • Add a collapsible "Citation for Research" section using HTML
    / for better README organization.
  • Introduce explanatory text instructing researchers to cite the project when relevant.
  • Embed a BibTeX-formatted citation block with authors, title, publication year, publisher, DOI, URL, and series information.
 README.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 20, 2026 •
edited
Loading

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

Two "Citation for Research" sections were added to README.md, each containing an identical collapsible BibTeX entry for MCP-Unity; one appears after the Star History section and the other before the Unity AI Tools section.

Changes

Cohort / File(s) Summary
Documentation Citations
README.md		 Added two collapsible "Citation for Research" sections containing the same BibTeX entry for MCP-Unity; inserted after Star History and before Unity AI Tools (+19 lines)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Two citations we now weave,
In folded leaves they softly cleave,
A BibTeX note for minds that seek,
Quietly nested, tidy, meek,
Hop on—researchers, take a peek! 🥕📚

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete, missing several required template sections including Type of Change, Changes Made, Testing, Related Issues, and Additional Notes details. Complete the description by filling in the Type of Change (Documentation update), explicitly listing Changes Made, and addressing other required template sections.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding citation information to the README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

sourcery-ai[bot]
sourcery-ai bot reviewed Jan 20, 2026
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copilot AI reviewed Jan 20, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds a citation section to the README for researchers who want to reference the Unity-MCP project in their work. The citation is for a paper presented at SIGGRAPH Asia 2025 Technical Communications.

Changes:

  • Added a collapsible citation section with BibTeX format for academic reference

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@dsarno
Copy link
Collaborator

dsarno commented Jan 21, 2026

👍🏼

@msanatan msanatan self-requested a review January 21, 2026 16:22
@msanatan
Update README.md spacing
10ae05d 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@msanatan msanatan merged commit d2408f0 into main Jan 21, 2026
2 checks passed
@msanatan msanatan deleted the Scriptwonder-patch-1 branch January 21, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Copilot code review Copilot Copilot left review comments

@msanatan msanatan msanatan approved these changes

Assignees

@Scriptwonder Scriptwonder

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Scriptwonder @dsarno @msanatan